Skip to content

feat: update qa job for tagging#21

Merged
roderik merged 3 commits intomainfrom
qa-tag
Sep 17, 2025
Merged

feat: update qa job for tagging#21
roderik merged 3 commits intomainfrom
qa-tag

Conversation

@roderik
Copy link
Copy Markdown
Member

@roderik roderik commented Sep 17, 2025

  • Added new CLI options for configuring static node parameters, including domain, namespace, service name, pod prefix, and ConfigMap names for genesis and static nodes.
  • Updated descriptions for existing options to enhance clarity and usability.

Summary by Sourcery

Add new CLI options for configuring static node parameters and genesis/static-nodes ConfigMaps, and update the QA workflow tagging job to grant write permissions and correctly use the GitHub token and commit user metadata.

New Features:

  • Introduce --static-node-domain, --static-node-namespace, --static-node-service-name, and --static-node-pod-prefix CLI options for constructing static node hostnames
  • Add --genesis-configmap-name and --static-nodes-configmap-name CLI options to specify ConfigMap names for generated payloads
  • Add --faucet-artifact-prefix CLI option to configure prefixes for faucet ConfigMaps and Secrets

Enhancements:

  • Grant write permission on contents in the QA workflow
  • Rename commit_author_name/email to commit_user_name/email in the release step
  • Expose GITHUB_TOKEN via the PAT_TOKEN environment variable for the release action

…rkflow

- Adjust permissions for contents, pull-requests, issues, and security-events to 'write' in the QA workflow configuration.
- Update commit user details to ensure proper attribution during automated commits.
- Added new CLI options for configuring static node parameters, including domain, namespace, service name, pod prefix, and ConfigMap names for genesis and static nodes.
- Updated descriptions for existing options to enhance clarity and usability.
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Summary of Changes

Hello @roderik, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request enhances the "network-bootstrapper" tool by introducing new command-line options that provide finer control over static node configuration and the naming of generated ConfigMaps. These additions aim to improve the flexibility and clarity of the tool, particularly for QA processes involving network tagging, by allowing users to specify critical parameters directly via the CLI and ensuring the documentation reflects these capabilities.

Highlights

  • New CLI Options: Introduced several new command-line options to the "network-bootstrapper generate" command, allowing for more granular configuration of static node parameters such as service name, pod prefix, and ConfigMap names for genesis and static nodes.
  • Documentation Clarity: Reordered and updated the descriptions for existing CLI options in the "README.md" to improve clarity and usability for users configuring network bootstrapping.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@github-actions github-actions Bot added the qa:running QA workflow is currently running label Sep 17, 2025
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Sep 17, 2025

To view in Slack, search for: 1758134045.967199

@github-actions github-actions Bot added the status:ready-for-review Pull request is ready for review label Sep 17, 2025
Copy link
Copy Markdown
Contributor

@sourcery-ai sourcery-ai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey there - I've reviewed your changes and they look great!

Prompt for AI Agents
Please address the comments from this code review:

## Individual Comments

### Comment 1
<location> `.github/workflows/qa.yml:140-139` </location>
<code_context>
           branch: main
           file_pattern: 'package.json **/package.json charts/**/Chart.yaml charts/**/README.md README.md'
-          github_token: ${{ env.PAT_TOKEN }}
-          commit_author_name: 'SettleMint Release Bot'
-          commit_author_email: 'support@settlemint.com'
+          commit_user_name: 'SettleMint Release Bot'
+          commit_user_email: 'support@settlemint.com'
+        env:
</code_context>

<issue_to_address>
**issue (bug_risk):** Renaming 'commit_author_name' to 'commit_user_name' may break compatibility.

Verify that the action supports 'commit_user_name' and 'commit_user_email' before making this change, as using unsupported keys may prevent the commit step from working correctly.
</issue_to_address>

### Comment 2
<location> `.github/workflows/qa.yml:141-142` </location>
<code_context>
-          commit_author_email: 'support@settlemint.com'
+          commit_user_name: 'SettleMint Release Bot'
+          commit_user_email: 'support@settlemint.com'
+        env:
+          GITHUB_TOKEN: ${{ env.PAT_TOKEN }}

       - name: Docker meta
</code_context>

<issue_to_address>
**🚨 issue (security):** Setting GITHUB_TOKEN from PAT_TOKEN may have unintended effects.

Using a PAT for GITHUB_TOKEN increases permissions and may affect auditability and access control. Confirm this is required and that PAT_TOKEN is securely handled.
</issue_to_address>

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Comment thread .github/workflows/qa.yml
commit_message: "chore(release): sync generated assets [skip ci]"
branch: main
file_pattern: 'package.json **/package.json charts/**/Chart.yaml charts/**/README.md README.md'
github_token: ${{ env.PAT_TOKEN }}
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

issue (bug_risk): Renaming 'commit_author_name' to 'commit_user_name' may break compatibility.

Verify that the action supports 'commit_user_name' and 'commit_user_email' before making this change, as using unsupported keys may prevent the commit step from working correctly.

Comment thread .github/workflows/qa.yml
Comment on lines +141 to +142
env:
GITHUB_TOKEN: ${{ env.PAT_TOKEN }}
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚨 issue (security): Setting GITHUB_TOKEN from PAT_TOKEN may have unintended effects.

Using a PAT for GITHUB_TOKEN increases permissions and may affect auditability and access control. Confirm this is required and that PAT_TOKEN is securely handled.

@roderik roderik merged commit 26acc79 into main Sep 17, 2025
10 checks passed
@roderik roderik deleted the qa-tag branch September 17, 2025 18:35
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request introduces new CLI options for configuring static node parameters and updates the README accordingly. The changes are logical and improve configurability. My review includes a suggestion to improve the formatting of the updated documentation for better readability.

Comment thread README.md
Comment on lines +154 to +160
--static-node-domain <domain> DNS suffix appended to validator peer hostnames for static-nodes entries.
--static-node-namespace <name> Namespace segment inserted between service name and domain for static-nodes entries.
--static-node-service-name <name> Headless Service name used when constructing static-nodes hostnames.
--static-node-pod-prefix <prefix> StatefulSet prefix used when constructing validator pod hostnames.
--genesis-configmap-name <name> ConfigMap name that stores the generated genesis.json payload.
--static-nodes-configmap-name <name> ConfigMap name that stores the generated static-nodes.json payload.
--faucet-artifact-prefix <prefix> Prefix applied to faucet ConfigMaps and Secrets.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The alignment of the option descriptions is inconsistent, which harms readability. For better presentation, all descriptions should be vertically aligned. While I can only suggest a change for the new options, please consider applying this alignment to all options in this section for consistency.

Suggested change
--static-node-domain <domain> DNS suffix appended to validator peer hostnames for static-nodes entries.
--static-node-namespace <name> Namespace segment inserted between service name and domain for static-nodes entries.
--static-node-service-name <name> Headless Service name used when constructing static-nodes hostnames.
--static-node-pod-prefix <prefix> StatefulSet prefix used when constructing validator pod hostnames.
--genesis-configmap-name <name> ConfigMap name that stores the generated genesis.json payload.
--static-nodes-configmap-name <name> ConfigMap name that stores the generated static-nodes.json payload.
--faucet-artifact-prefix <prefix> Prefix applied to faucet ConfigMaps and Secrets.
--static-node-domain <domain> DNS suffix appended to validator peer hostnames for static-nodes entries.
--static-node-namespace <name> Namespace segment inserted between service name and domain for static-nodes entries.
--static-node-service-name <name> Headless Service name used when constructing static-nodes hostnames.
--static-node-pod-prefix <prefix> StatefulSet prefix used when constructing validator pod hostnames.
--genesis-configmap-name <name> ConfigMap name that stores the generated genesis.json payload.
--static-nodes-configmap-name <name> ConfigMap name that stores the generated static-nodes.json payload.
--faucet-artifact-prefix <prefix> Prefix applied to faucet ConfigMaps and Secrets.

@github-actions github-actions Bot added status:merged Pull request has been merged status:ready-for-review Pull request is ready for review qa:success QA workflow passed successfully feat New feature and removed status:ready-for-review Pull request is ready for review status:merged Pull request has been merged qa:running QA workflow is currently running labels Sep 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

feat New feature qa:success QA workflow passed successfully status:ready-for-review Pull request is ready for review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant